Resource Path: /api/method/{id}
Uri: http://doc.jamsscheduler.com/api/method/{id}
Description
Gets a method definition by ID
Parameters
| Name | Description | Data Type |
|---|
| id | ID of the method definitionid of the method definition | integer |
Response
The response body is of type Method.
OK
Overview
 |
Method
 |
description : string
|
|
lastChange : string
|
|
lastChangedBy : string
|
|
lastChangeUTC : string
|
|
methodID : integer
|
|
methodName : string
|
|
methodTypeID : integer
|
|
methodTypeName : string
|
|
template : string
|
 |
parameters : Array[Param]
|
allowEntry : boolean
|
|
dataType : string
|
|
defaultFormat : string
|
|
defaultValue : string
|
|
encrypt : boolean
|
|
helpText : string
|
|
hide : boolean
|
|
inherited : boolean
|
|
jobID : integer
|
|
lastChangeUTC : string
|
|
length : integer
|
|
mustFill : boolean
|
|
parameterOrigin : string
|
|
paramId : integer
|
|
paramName : string
|
|
prompt : string
|
|
required : boolean
|
|
sequence : integer
|
|
uppercase : boolean
|
|
validationData : string
|
|
validationType : string
|
|
variableID : integer
|
|
variableName : string
|
|
variableNameIsRelative : boolean
|
|
|
propertyName : string
|
|
categoryName : string
|
|
categorySortOrder : integer
|
|
displayName : string
|
|
propertyId : integer
|
|
typeName : string
|
|
typeNameSSO : string
|
|
toolTip : string
|
|
description : string
|
|
editor : string
|
|
mergeOption : string
|
|
sortOrder : integer
|
|
inheritedFromType : string
|
|
inheritedFromId : integer
|
|
inheritedFromName : string
|
|
readOnly : boolean
|
|
browsable : boolean
|
|
defaultValue : object
|
|
currentValue : object
|
|
|
encryptionId : integer
|
|
newEncryptedValue : string
|
|
|
|
propertyName : string
|
|
categoryName : string
|
|
categorySortOrder : integer
|
|
displayName : string
|
|
propertyId : integer
|
|
typeName : string
|
|
typeNameSSO : string
|
|
toolTip : string
|
|
description : string
|
|
editor : string
|
|
mergeOption : string
|
|
sortOrder : integer
|
|
inheritedFromType : string
|
|
inheritedFromId : integer
|
|
inheritedFromName : string
|
|
readOnly : boolean
|
|
browsable : boolean
|
|
defaultValue : object
|
|
currentValue : object
|
|
|
|
propertyName : string
|
|
categoryName : string
|
|
categorySortOrder : integer
|
|
displayName : string
|
|
propertyId : integer
|
|
typeName : string
|
|
typeNameSSO : string
|
|
toolTip : string
|
|
description : string
|
|
editor : string
|
|
mergeOption : string
|
|
sortOrder : integer
|
|
inheritedFromType : string
|
|
inheritedFromId : integer
|
|
inheritedFromName : string
|
|
readOnly : boolean
|
|
browsable : boolean
|
|
defaultValue : object
|
|
currentValue : object
|
|
|
See Also